4.8 批量编辑外部用户(有管理接口用户目录)

基本信息

Path: /api/v1/externalUser/batchUpdate

Method: POST

接口描述:

注意:该接口文档只针对有管理接口的用户目录,即用户目录数据来源为外部的用户目录

  1. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
  2. 一次最多批量编辑10000个用户
  3. 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
  4. 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户管理”页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
  5. 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
  6. 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
  7. 群组ID获取方式,可通过openAPI的外部用户群组查询接口获取

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注 其他信息
idList string[] 必须 外部用户ID数组
userDirectoryId string 必须 所属用户目录ID
value object 必须 修改内容对象
├─userPolicyId string 非必须 用户策略ID
├─authComposeId string 非必须 认证策略ID
├─status number 非必须 启用状态:0禁用,1启用。如要调整该字段值,请在fieldDataSource中将status字段数据来源修改为'local'
├─description string 非必须 描述。如要调整该字段值,请在fieldDataSource中将description字段数据来源修改为'local'
├─expiredTime string 非必须 '0' 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期。如要调整该字段值,请在fieldDataSource中将expiredTime字段数据来源修改为'local'
├─ext object 非必须 拓展字段
├─├─fieldDataSource object 非必须 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─description string 非必须 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─expiredTime string 非必须 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─status string 非必须 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─inheritGroup number 非必须 1 继承所属组织架构的授权应用:0不继承,1继承
├─roleEditWay string 非必须 'append' 角色编辑方式,'reset'重置,'append'追加
├─roleIdList string[] 非必须 角色ID列表
├─roleNameList string[] 非必须 角色名列表 如果没有传roleIdList,会以roleNameList为准,2.1.15新增参数
├─resourceEditWay string 非必须 'append' 应用分类编辑方式,'reset'重置,'append'追加
├─resourceGroupIdList string[] 非必须 应用分类ID列表
├─resourceIdList string[] 非必须 应用ID列表 ID列表和名称列表传一个即可,如果都传,以ID列表为准
├─bandEditWay string 非必须 'append' 群组编辑方式,'reset'重置,'append'追加
├─bandIdList string[] 非必须 群组ID列表
├─bandNameList string[] 非必须 群组名称列表,如果没有传bandIdList,会以bandNameList  

请求示例

{
    "userDirectoryId": "04bac940-fbf9-11ea-9906-116c10ccbb30",
    "idList":[
        "04bac940-fbf9-11ea-9906-116c10ccbb30",
        "e1ded190-5964-11eb-a9a0-931833117fac"
    ],
    "value":{
        "expiredTime": 0,
        "bandIdEditWay": "append",
        "bandIdList": [ "5559f620-5583-11eb-880a-913383f106f2", "6659f620-5583-11eb-880a-913383f106f2"],
        "roleIdEditWay": "append",
        "roleIdList": [ "7759f620-5583-11eb-880a-913383f106f2", "6559f620-5583-11eb-880a-913383f106f2"],
        "status": 0
    }
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code":0,
    "data":{},
    "msg":"请求成功"
}

错误信息

错误提示 错误码
请输入正确的所属组织架构格式:请以“/”开头,组织架构路径不能有连续“/”,且不能以“/”结尾 7201
角色编辑方式错误,只允许reset重置,append追加 7201
应用和应用分类编辑方式错误,只允许reset重置,append追加 7201
参数检查出错 10000001
批量编辑操作数量已经超过上限:10000 10000000
外部认证服务器不存在 77200004
认证策略不存在 77200004
用户策略不存在 77200004
角色不存在 77200001
应用不存在 77200001
应用分类不存在 77200001
保存失败,关联的角色不存在 77200004
保存失败,关联的应用不存在或已被删除 77200004
群组不存在或已被删除 77200004
操作失败 10000000
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""